home *** CD-ROM | disk | FTP | other *** search
/ Network Support Library / RoseWare - Network Support Library.iso / logbatch / dosqu.exe / DOSQUE.DOC next >
Text File  |  1993-10-26  |  21KB  |  508 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.                                     DOSque
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.                               (C)Copyright 1993
  23.  
  24.                                       by
  25.  
  26.                                  Skip Bremer
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.                                  Version 2.1
  35.  
  36.                                    10/26/93
  37.  
  38.                               TABLE OF CONTENTS
  39. ==============================================================================
  40.  
  41.      Topic                                                          Section
  42.      -----                                                          -------
  43.  
  44.      Introduction ......................................................  1
  45.  
  46.      Miscellaneous .....................................................  2
  47.           Requirements
  48.           Limits
  49.           Start-Up Options
  50.           Renaming DOSque
  51.           Required Files
  52.  
  53.      Quick Start .......................................................  3
  54.  
  55.      Start-Up Batch File ...............................................  4
  56.  
  57.      Commands ..........................................................  5
  58.  
  59.      Setup .............................................................  6
  60.  
  61.      Types of Jobs .....................................................  7
  62.  
  63.      Editing Jobs ......................................................  8
  64.  
  65.      DOSque Screen .....................................................  9
  66.  
  67.      Temporary Batch File .............................................. 10
  68.  
  69.      Credits ........................................................... 11
  70.  
  71.      Shareware ......................................................... 12
  72.           Evaluation Copy
  73.           Distribution
  74.           Registration
  75.           Disclaimer
  76.  
  77.                                INTRODUCTION (1)
  78. ==============================================================================
  79.  
  80. DOSque was designed as a simple yet effective queue system for both network
  81. and DOS stand-alone environments.  We work in an environment that demands an
  82. easily changeable, concise queue system to help us provide proper support for
  83. a large Netware 386 (tm) wide area network domain spanning Texas.  We need a
  84. DOS command queue to help us perform necessary network activities during
  85. non-production periods.  Because we could not find one that offers the
  86. flexibility we required, we wrote our own.  We hope it helps you as much as it
  87. has helped us in controlling our environment.  Please use DOSque as you see
  88. fit, but if you continue to use it, please abide with the Shareware section of
  89. this documentation.
  90.  
  91. Here is a quick overview of DOSque:
  92.  
  93. o    Small 25K executable.
  94.  
  95. o    Near unlimited number of queue items.
  96.  
  97. o    No memory taken by the queue system when running commands.
  98.  
  99. o    Run anything from the queue system including Terminate and Stay Resident
  100.      programs (TSRs).
  101.  
  102. o    No unnecessary restrictions like queue jobs being scheduled too close
  103.      together, etc.
  104.  
  105.  
  106. DOSque was written in Turbo Pascal 7.0 (real mode) with assembly extensions.
  107.  
  108.                               MISCELLANEOUS (2)
  109. ==============================================================================
  110.  
  111. Requirements
  112. ------------
  113. DOSque's only two known requirement is that it must run under DOS 3.1 or
  114. higher and it obviously requires a dedicated workstation when actively
  115. queuing.  It also runs fine from a Windows DOS session and from DOS shells.
  116.  
  117. Limits
  118. ------
  119. Maximum queue items: realistically nearly unlimited, actually 500
  120. Maximum length of queue commands: 58
  121.  
  122. Start-Up Options
  123. ----------------
  124. DOSque must started with the command DOSque in a batch file except for the
  125. first time when it is started with the /MAKE option.  See the Start-Up Batch
  126. File Setup section for complete information on this subject.
  127.  
  128. Required Files
  129. --------------
  130. The following files are necessary to run DOSque:
  131.  
  132. DOSQUE.EXE     The DOSque program.
  133.  
  134. DOSQUE.INI     The DOSque file that holds the optional encrypted password.
  135.  
  136. DOSQUE.DAT     The DOSque data file that holds all queue jobs and their
  137.                specific information.  You should not edit this file.
  138.  
  139. DOSQUE.LOG     The log file maintained by DOSque. 
  140.  
  141. QUE.BAT        The start-up batch file made the first time you run DOSque.
  142.                This file may be called any name you wish and must be placed
  143.                in your path.
  144.  
  145.                                QUICK START (3)
  146. ==============================================================================
  147.  
  148. To quickly get the queue system up and running, do the following (check the
  149. documentation later for specifics):
  150.  
  151. o    Place DOSQUE.EXE in the directory you wish to run it from.
  152.  
  153. o    Run DOSQUE.EXE /MAKE once.
  154.  
  155. o    Edit/rename the resulting QUE.BAT as necessary.
  156.  
  157. o    Place QUE.BAT in your path.
  158.  
  159. o    Run QUE.BAT (or whatever you renamed it to).
  160.  
  161. o    Add jobs as required.
  162.  
  163.                            START-UP BATCH FILE (4)
  164. ==============================================================================
  165.  
  166. As part of the initial setup performed by running DOSQUE.EXE /MAKE once, the
  167. file QUE.BAT will be made in DOSque's home directory.  You should place
  168. DOSQUE.EXE in the directory you wish to run it from before running it for the
  169. first time because the home directory information is used in creating this
  170. batch file.  If you have already run it once and wish to move DOSQUE.EXE, then
  171. you may either run DOSQUE.EXE again with a /MAKE parameter (creating a new
  172. QUE.BAT) or simply edit the existing QUE.BAT.
  173.  
  174. QUE.BAT should be in your path for easier loading, but DOSQUE.EXE does not
  175. need to be there.  DOSQUE.INI and DOSQUE.DAT will always be in the same
  176. directory as DOSQUE.EXE.
  177.  
  178. Here is a commented queue.BAT:
  179.  
  180. @echo off                          ;Cosmetics
  181. ::this file must be in your path
  182. f:                                 ;Change to home drive and directory
  183. cd \login
  184. ::previous run file exists?        
  185. if exist dq$run.bat del dq$run.bat ;Delete previous run file
  186. dosque /batch %1                   ;Run DOSque
  187. ::no command?
  188. if not exist dq$run.bat goto END   ;Did we quit?
  189. ::run temporary batch file
  190. call dq$run                        ;Run batch file made by DOSque
  191. f:                                 ;Change to home again
  192. cd \login
  193. ::do it again                      ;Keep running the batch file (and the queue)
  194. f:                                 ;Change to home drive and directory
  195. cd \login
  196. que /rerun
  197. :END                               ;Place to go to when quitting
  198.  
  199. QUE.BAT changes to its home directory only to make it easier for you to manage
  200. a queue environment.  By keep the various batch file commands that DOSque may
  201. call to perform your jobs in one location, it is easier to manage the entire
  202. queue situation.  Of course, directly called DOS commands have no need to be
  203. in this directory.
  204.  
  205.                                  COMMANDS (5)
  206. ==============================================================================
  207.  
  208. DOSque has very few commands.  They are listed below along with an
  209. explanation of their activities.
  210.  
  211. F1   HELP      DOSque contains context sensitive help.  Press it anytime.
  212.  
  213. F2   ADD       This key will add new job definitions to the queue.  See the
  214.                Editing Jobs section for more.
  215.  
  216. F3   LOG       This key will view the END of the DOSQUE.LOG file, thereby
  217.                showing you the most recent queue activity.  When viewing the
  218.                log, the DEL key will delete it.  You should do this when the
  219.                log becomes so large that it takes noticeable time for DOSque to
  220.                find the end of it for viewing.  Although writing to it never
  221.                slows down no matter how large it is, reading can become slow
  222.                because DOSque reads sequentially through the file to find the
  223.                end of it for viewing.
  224.  
  225. F4   CHANGE    This key will allow you to change the highlighted job's
  226.                definition.  See the Editing Jobs section for more.
  227.  
  228. F5   COPY      This key will let you copy the highlighted job so that the new
  229.                job can then be more easily defined when editing it.  See the
  230.                Editing Jobs section for more.
  231.  
  232. F6   SHOW      This key toggles the Next Run/Last Run column's information.
  233.                Next Run shows in order the jobs as they will run data and time
  234.                wise.  Last Run shows the history of the last jobs run, also in
  235.                order.
  236.  
  237. F7   STATUS    This key toggles the highlighted job's status from Ready to
  238.                Hold.  When a job is ready, it will run at its queue data and
  239.                time.  When on hold, it will not.  If you take a job off hold
  240.                during the same day (date) that it was supposed to run, it will
  241.                run immediately, else it will automatically cycle to its next
  242.                run date.  When taking a job like this off hold, you will be
  243.                prompted if the job is going to run immediately.  The same
  244.                holds true when re-starting DOSque or returning from the DOS
  245.                shell option:  if there are any jobs ready to go, you will be
  246.                prompted with an option to temporarily place them on hold so
  247.                you can evaluate the queue situation first.
  248.  
  249. F8   DELETE    This key will let you delete the highlighted job from the
  250.                queue.  Once deleted, you can not undo it.
  251.  
  252. F9   RUN       This key will let you run the highlighted job, even though its
  253.                queue activation time has not arrived.  This does not change
  254.                its next queue time.
  255.  
  256. F10  QUIT      This key quits DOSque.  If a password has been made, then this
  257.                option requires the password.
  258.  
  259. ÆF1  DOS       This key allows you to open a temporary DOS session.  If a
  260.                password has been made, then this option requires a password.
  261.  
  262. ÆF10 PASSWORD  This key allows you to define or remove the optional system
  263.                password.  Among other times discussed above, the password will
  264.                be required when attempting to interrupt the screen saver
  265.                function.  This, of course, is not true if DOSque itself is
  266.                interrupting the screen saver to accomplish a queue job.
  267.  
  268. ESC  PREVIOUS  This key backs you out of prompts, if necessary.
  269.  
  270.                                   SETUP (6)
  271. ==============================================================================
  272.  
  273. To set up DOSque, place DOSQUE.EXE in the directory from which you would like
  274. it to run.  This directory does not have to be in your path.  From this
  275. directory, run DOSQUE /MAKE.  This command will make the sample start-up batch
  276. file, QUE.BAT.  You should then edit this batch file if needed and then placed
  277. it somewhere in your path.  That is all there is to it.  You are now ready to
  278. run QUE.BAT which will activate your queue system.
  279.  
  280.                               TYPES OF JOBS (7)
  281. ==============================================================================
  282.  
  283. There are basically two types of queue jobs that can be set up and run with
  284. DOSque:  weekly and date specific.
  285.  
  286. Weekly jobs are defined as follows:
  287.  
  288. o    runs at a specific time on the same day or days every week.
  289.  
  290. o    runs at a specific time every day.
  291.  
  292. Date Specific jobs are defined as follows:
  293.  
  294. o    runs at a specific time once in a lifetime.
  295.  
  296. o    runs at a specific time once each month.
  297.  
  298. o    runs at a specific time each year.
  299.  
  300.  
  301. See the Editing Jobs section for a complete breakdown on how to set up these
  302. types of jobs.
  303.  
  304.                                EDITING JOBS (8)
  305. ==============================================================================
  306.  
  307. Jobs are set up and edited by pressing F2 ADD or F4 EDIT from the main queue
  308. screen.  A pop-up editing window appears asking the following questions.
  309.  
  310. DOS Command:  This is the actual DOS command that will be placed in the
  311. temporary batch file for running when this job meets its next queue time.  The
  312. command can be any valid DOS command, including Terminate and Stay Resident
  313. (TSR) programs.  If you have more than one DOS command required, then place
  314. them into a batch file and place the path (if required) and the name as the
  315. answer to this question.
  316.  
  317. Hour:  This is the hour of the day that this job will run.  It is always
  318. required and must be issued in 24 hour time.
  319.  
  320. Minute:  This is the minute of the hour of the day that this job will run.  It
  321. is always required.
  322.  
  323. Weekly/Date Specific:  Enter a W for weekly or a D for date specific.  Note
  324. that this item can always be changed later.  In fact, you can enter the below
  325. information for both weekly and date specific for this job and both will be
  326. remembered.  Then you may later switch between the two as desired by editing
  327. this job.  The answer you give here will dictate the next questions that are
  328. asked of you while editing the job.
  329.  
  330. If weekly...
  331.  
  332. Su Mo Tu We Th Fr Sa:  Place a Y in each day that you wish this job to run at
  333. the specified time.  The job will run on those days forever unless you kill
  334. the job or place it on hold (or you, of course, quit DOSque).
  335.  
  336. If date specific...
  337.  
  338. Day of month:  Enter the day between 1 and 31 of the month that you wish the
  339. job to run.  This is a required field for date specific jobs.  If you do not
  340. fill in the following month and year fields, then this job will run every
  341. month on this day at the specified time forever, else it can run on specific
  342. months (and/or years) on this month day.
  343.  
  344. Month:  Enter the month for this job to run on the month day.  If nothing is
  345. entered, then it will run every month.
  346.  
  347. Year:  Enter the year that this job should run on the month and day specified.
  348. If nothing is entered here, then it will run on the specified month and day
  349. every year.  If a year is given, then this becomes a once in a lifetime job.
  350.  
  351.                               DOSQUE SCREEN (9)
  352. ==============================================================================
  353.  
  354. The header at the top of the DOSque screen looks something like this:
  355.  
  356.                         |-------Days----------|or|--Date--|  |Next Run|
  357. DOS Command      HH:MM  Su Mo Tu We Th Fr Sa Su  Da Mo Year  MM-DD-YYYY  Status
  358. or                                                           |Last Run|
  359.  
  360. DOS Command: The actual command to be run for this job.
  361.  
  362. HH:MM: The job time.
  363.  
  364. Su Mo Tu We Th Fr Sa Su:  The days this job will run ONLY if this is a
  365. "weekly" job.
  366.  
  367. Da Mo Year:  The month day and optionally the month and optionally the year
  368. that this job will run ONLY if this is a "date specific" job.
  369.  
  370. Next Run:  This shows, in sorted order, the next date and time each job will
  371. run.
  372.  
  373. Last Run:  This shows, in sorted order, the last time each job ran.
  374.  
  375. Status:  One of the following:
  376.  
  377.      Ready  - Job is set up properly and will run at its next queue time.
  378.      Hold   - Job is on hold and can not run again until taken off hold with
  379.               the F7 key.  If a job is taken off hold on the same day on which
  380.               it is now late for its run, you will be asked to confirm as the
  381.               job will run immediately.
  382.      Bad    - Job is not set up properly; probably an incomplete date specific
  383.               edit resulting in no feasible run date.
  384.      Overdue- Job is ready but could not yet run.  This is probably resulting
  385.               from a job previous to this job that is still running and has
  386.               made this job go past its run time.  As soon as the other job
  387.               finishes, and DOSque returns to its main screen, this job will
  388.               become Ready and will run immediately - ONLY if the day is still
  389.               the same as that on which the job was queued to run.  If the day
  390.               has become the next calendar day, then this job's next run date
  391.               will cycle to the next allowable run time for this job.
  392.               Therefore, be careful when grouping jobs around the bewitching
  393.               hour (12:00 midnight)!
  394.  
  395.                           TEMPORARY BATCH FILE (10)
  396. ==============================================================================
  397.  
  398. When a job runs, DOSque makes a temporary batch file containing '@echo off'
  399. and the actual job DOS command.  The name of this batch file is DQ$RUN.BAT and
  400. it will be located in DOSque's home directory.
  401.  
  402. Example
  403. -------
  404. If a queue item's DOS command was this:
  405.  
  406.   copy thisfile f:\there
  407.  
  408. then the corresponding batch file would look like this:
  409.  
  410. @echo off
  411. copy thisfile f:\there
  412.  
  413.                                  CREDITS (11)
  414. ==============================================================================
  415.  
  416. Turbo Pascal is a trademark of Borland International.
  417.  
  418. MS-DOS is a trademark of Microsoft Corporation.
  419.  
  420. Netware and Novell are registered trademarks of Novell, Inc.
  421.  
  422. Windows is a registered trademark of Microsoft Corporation.
  423.  
  424. Trademarks of other companies or products mentioned in this file are the
  425. property of their respective companies.
  426.  
  427.                                 SHAREWARE (12)
  428. ==============================================================================
  429.  
  430. Evaluation Copy
  431. ---------------
  432. THIS IS NOT FREE SOFTWARE!  You may evaluate and use this product, but if you
  433. decide to make use of it on a regular basis, you must register your copy.
  434.  
  435. Note:  Businesses, government agencies and institutions are required to
  436. register this software package before extended use.
  437.  
  438. We offer several inducements to you for registering.  First of all, you will
  439. receive the most up-to-date copy of the program -- and we update the program
  440. on a regular basis.  Second, you will never see the shareware message again.
  441. Make no mistake, however -- this is a fully functional version of DOSque that
  442. is not "crippled" in any way.
  443.  
  444. Distribution
  445. ------------
  446. This is "user-supported" software.  You are hereby granted permission to
  447. distribute this evaluation copy of DOSque and its documentation, subject to
  448. the following conditions:
  449.  
  450. 1.  Shareware DOSque may be distributed freely without charge in evaluation
  451.     form only.
  452.  
  453. 2.  DOSque in its shareware form may not be sold, licensed, or a fee charged
  454.     for its use.  If a fee is charged in connection with DOSque, it must
  455.     cover the cost of copying or dissemination only.  Such charges must be
  456.     clearly identified as such by the originating party.  Under no
  457.     circumstances may the purchaser be given the impression that he is buying
  458.     a registered version of DOSque.
  459.  
  460. 3.  Shareware DOSque must be presented as a complete unit with documentation.
  461.     Neither DOSque nor its documentation may be amended or altered in any way
  462.     without permission of the copyright holder.
  463.  
  464. 4.  By granting you the right to distribute the evaluation form of DOSque,
  465.     you do not become the owner of DOSque in any form.
  466.  
  467. Any other use, distribution or representation of DOSque is expressly
  468. forbidden without written consent from the author.
  469.  
  470. Registration
  471. ------------
  472. The non-commercial single-user registration fee for DOSque is $40.00 US.  
  473. ($5 shipping is included.)
  474.  
  475. The commercial/government and multi-system site fee for DOSque is:
  476.  
  477.      Non-network environment:
  478.           Per machine        - $110.00 US.
  479.      Network environment:
  480.           Per server         - $160.00 US.
  481. ($10 shipping is included.)
  482.  
  483. Send a check, money order or company P.O. for the appropriate amount to:
  484.  
  485.           Skip Bremer - DOSque
  486.           3401 Cactus Wren Way
  487.           Austin, Texas 78746
  488.  
  489. No credit cards.  Thank you.
  490.  
  491. Telephone: 512-328-2465
  492. Compuserve ID: 71614,2556
  493.  
  494. Disclaimer
  495. ----------
  496. The author does not warrant that the functions contained in this program will
  497. meet your requirements or that the program operation will be uninterrupted or
  498. error free.
  499.  
  500. The author specifically disclaims all other warranties, expressed or implied,
  501. including but not limited to implied warranties of fitness for any particular
  502. purpose and of merchantability.
  503.  
  504. In no event will the author be liable to you for any damages, including but
  505. not limited to any lost profits, lost savings, commercial damage or other
  506. incidental or consequential damages arising out of the use or inability to use
  507. this program, or for any claim by any other party.
  508.